no_que_investir                package:unknown                R Documentation

SISTEMA PARA DECISO DE QUAIS AES DEVEM SER COMPRADAS 

Description:

     A funo acessa as cotaes das aes por meio do pacote GetHFData. Calcula o patrimnio total e a proporo 
     do capital investido em cada empresa e em qual delas a diferena entre o capital investido e o objetivo  a 
     mnima, indicando que  onde o usurio deve investir. A funo fornece um grfico com as propores do capital 
     investido e os objetivos, e destaca a ao que deve ser comprada. Por fim, exibe um dataframe com os cdigos 
     das aes, as cotaes e a diferena (reais e nmero de aes) do capital investido em relao aos objetivos 
     para cada empresa.

Usage:

     no_que_investir(dataframe = planilha)

Arguments:

     Dataframe: nome da planilha que possui os dados. O arquivo deve ser uma tabela contendo, obrigatoriamente, as 
     colunas investimento, objetivo e quantidade_acoes. 

Value:

     Plot com pontos azuis (representando os objetivos) e verdes (indicando a proporo do capital efetivamente           
     investido) e a diferena entre essas duas variveis escrita em nmeros vermelhos, para cada empresa informada 
     na planilha. Um asterisco vermelho indica em qual empresa o resultado dessa subtrao  o menor, o que informa 
     ao usurio que  nessa empresa que o aporte mensal deve ser alocado.

     Dataframe com os cdigos das aes de cada empresa, suas cotaes, e a diferena tanto em reais quanto em 
     nmeros de aes de cada empresa em relao aos seus objetivos.

Warning:

     A funo  interrompida quando, nas colunas investimento e quantidade_acoes houver algum dado faltante; e 
     quando, na coluna objetivo a soma de todos os valores no for igual a 1.

Note:

     Detalhes importantes para a formatao correta do arquivo de entrada:
       1 - Antes de dar incio  funo,  necessrio criar um objeto chamado planilha com a sua planilha de 
       controle por meio da funo read.table seguindo os seguintes parmetros: 
           a - header = TRUE, #a primeira linha da planilha original corresponde ao cabealho
           b - dec = #a separao decimal da planilha original  feita por ponto
           c - sep = ";", #o espaamento da planilha original  feito por pontos-e-vrgulas
           d - na.strings=c("") #preenche os eventuais espaos vazios da planilha com NAs.
       2 - A tabela precisa conter, obrigatoriamente, as colunas investimento, objetivo e quantidade_acoes.
       3 - A coluna investimento possui os cdigos das aes da carteira de investimentos do usurio (exemplo: 
       ABEV3) que sero utilizadas para que a funo busque, por meio do pacote GetHFData, as cotaes em um 
       repositrio da Bovespa;
       4 - A coluna objetivo possui a proporo do patrimnio que o usurio deseja ter investido em cada empresa. 
       Para indicar a proporo, use nmeros decimais obedecendo a seguinte grafia: 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 
       0.7, 0.8, 0.9 ou 1.0;
       5 - A coluna quantidade_acoes possui o nmero de aes de cada empresa que o usurio possui;
       6 - Alm dessas, recomenda-se que a tabela contenha duas colunas adicionais: uma que apresente o nome de 
       cada empresa por extenso e outra com seus respectivos CNPJ. Embora esses dados no sejam usados na anlise, 
        interessante manter todas as informaes organizadas para facilitar o processo de declarao de imposto de 
       renda;
       7 - A ordem das colunas no importa;

     Limitaes da funo
       1 - A funo  dependente do pacote GetHFData;
       2 - O R com frequncia possui dificuldade em se comunicar com o repositrio da Bovespa, ento seja 
       perseverante (tente rodar a funo mais de uma vez se a conexo no for estabelecida com sucesso) e paciente 
       (o R importa um grande volume de dados, o que demanda tempo);
       3 - O repositrio da Bovespa (ftp://ftp.bmf.com.br/MarketData/)  atualizado apenas uma vez por dia (em 
       horrios variveis), quando so inseridos os valores das cotaes do dia anterior. Sendo assim, as 
       informaes infelizmente possuem ao menos um dia de atraso, logo, no fornecem as cotaes em tempo real.

Author(s):
     Augusto Santos Rampasso
     augusto.santosr@gmail.com

Examples:

     planilha <- read.table("planilha_1.csv", header = TRUE, dec = ".", sep = ";", na.strings=c(""))
     no_que_investir(dataframe = planilha)

     planilha <- read.table("planilha_2.csv", header = TRUE, dec = ".", sep = ";", na.strings=c(""))
     no_que_investir(dataframe = planilha)
